home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 52 / Amiga Format AFCD52 (Issue 136, May 2000).iso / -serious- / workbench / clockcal / clockcal.doc < prev    next >
Text File  |  2000-02-28  |  8KB  |  193 lines
  1.  
  2. 1. INTRODUCTION
  3.  
  4. ClockCal opens a window on your WB containing up to  four
  5. analogue clock faces which can be configured to show  the
  6. current  time  in  different  world  locations,  with  or
  7. without  Daylight Saving Time in force, plus  a  calendar
  8. for  the  current (or any other) month. Gadgets exist  to
  9. toggle  the  display between just the  clocks,  just  the
  10. calendar  or  both.  Events may be noted  for  particular
  11. dates and those days will be highlighted in the calendar.
  12.  
  13. The  window sizing takes account of the title bar  height
  14. so should work irrespective of your system font, and safe
  15. guards  exist  to  prevent the  window  failing  to  open
  16. because  part of it is off screen etc. (since the  window
  17. changes size depending on how many clocks you have active
  18. and whether the calendar is on).
  19.  
  20. I  wrote  this  programme for  my  own  use  and  do  not
  21. anticipate  further development. It is Freeware.  If  you
  22. find it useful complements are always welcome!
  23.  
  24.  
  25. 2. INSTALLATION
  26.  
  27. None required. Copy the directory wherever you want it.
  28.  
  29.  
  30. 3. USAGE
  31.  
  32. Double  click the ClockCal icon. The window will open  in
  33. the  same  state as last time you closed it, in the  same
  34. position on the screen.
  35.  
  36. 3.1 CONFIGURING THE CLOCKS
  37.  
  38. The  Clocks.. gadget opens a new window containing a  set
  39. of  gadgets for each of the four possible clocks.  It  is
  40. essential that Clock 1 is set to show your local (system)
  41. time,  but with the correct time zone difference and  DST
  42. setting, as this clock is used to calculate GMT, which in
  43. turn  is used to calculate all the other clocks. Clock  1
  44. need  not be on, but it must be set right. Clocks with  a
  45. tick  in the ON checkbox will be displayed in the window.
  46. When  the DST checkbox is ticked the clock will have  the
  47. DST value (usually 1 hour) added to it. Note the timezone
  48. is set using a GMT +/- cycle gadget and a number of hours
  49. and  minutes  - do not put a sign in the time  difference
  50. box.
  51.  
  52. Close the window for the new settings to take effect.
  53.  
  54. 3.2 USING THE CALENDAR
  55.  
  56. The month displayed by the calendar always starts off  as
  57. the  current month. The cycle gadget enables you to  view
  58. different months (remember that the Shift key makes  this
  59. cycle  backwards!).  Going from December  to  January  or
  60. January  to December will also change the year,  but  any
  61. year  may be viewed by typing a different year in to  the
  62. year  gadget. The two tiny buttons beside the year gadget
  63. provide a convenient way of shifting the year up or  down
  64. by  one.  Note  that events will not be  highlighted  for
  65. years  before  1978.  I do not believe  the  calendar  is
  66. reliable for extreme dates but should be OK for the  next
  67. 40  years or so at least. (It shows 1900 and 2100 as leap
  68. years  - which they are not - although 2000 is, and  that
  69. is  correctly displayed (The full rule for leap years is:
  70. Years  exactly  divisible  by 4  are  leap  years  EXCEPT
  71. centenary   years,   but  in  the  case   of   millennial
  72. centenaries  like 1000 or 2000 they ARE leap  years  -  I
  73. think!)).
  74.  
  75. Clicking on a day will open the notes window, which lists
  76. events  noted for that date. Up to 20 one-line notes  can
  77. be  entered for a given date. Use the mouse to  highlight
  78. any existing note or an empty line. The text for the note
  79. can  be entered in the text gadget. The "Annual" checkbox
  80. should  be ticked for events like birthdays which  happen
  81. every  year,  and left clear for events like appointments
  82. which  relate  to  a specific date. These  two  different
  83. kinds  of events are highlighted in different colours  on
  84. the   calendar   (appointments  taking  precedence   over
  85. birthdays where both occur on the same day). You may also
  86. set  a number of days in the "Warning" gadget, which will
  87. put  up a reminder when the programme is started.  Use  0
  88. for no reminder.
  89.  
  90. After  setting these gadgets, use the SET button  to  set
  91. the  note. To delete a note, select it with the mouse and
  92. press DELETE. In either case the changes will not be made
  93. permanent  until you exit the window with the OK  gadget.
  94. The CANCEL gadget will discard the changes.
  95.  
  96. The  "Purge old events" checkbox causes old events to  be
  97. removed  from  the eventlist, but obviously those  marked
  98. "annual"  will  not be removed. Events are  only  removed
  99. when  new  notes  are set or deleted, but  there  is  one
  100. exception to this - when you check the purge checkbox for
  101. the  first  time, or uncheck it and check it  again,  old
  102. events  will  be deleted there and then. Thereafter  they
  103. will  only be removed when some other change is  made  to
  104. the  eventlist.  Note  that the  purge  checkbox  is  NOT
  105. associated with a particular date or a particular note.
  106.  
  107. The  "List  All" gadget lists the actual text file  which
  108. stores  the  events, using an external text  viewer.  The
  109. default is C:More, but you may change this in the fconfig
  110. file (see below).
  111.  
  112. The  three  slim buttons across the bottom of the  window
  113. have  the  following functions: the leftmost  resets  the
  114. calendar to the current month and year. The middle one is
  115. the  "only  show calendar" button, which  will  hide  the
  116. clocks.  If the clocks are already hidden, however,  they
  117. will  be restored by this button. Similarly the rightmost
  118. button  is the "only show clocks" gadget which will  hide
  119. or  restore the calendar. If only the clocks or only  the
  120. calendar  are  visible, you can toggle  between  them  by
  121. pressing  the appropriate button (if clocks  are  visible
  122. the  "only  show  calendar" button  will  switch  to  the
  123. calendar,  and  then the "only show clocks"  button  will
  124. take you back to the clocks).
  125.  
  126.  
  127. 4. OTHER CONFIGURATION OPTIONS
  128.  
  129. 4.1 fconfig file
  130.  
  131. This  is  a simple text file which should be in the  same
  132. directory  as the executable. You can use it to  set  the
  133. fonts  and colours used, and also the text viewer invoked
  134. to  list  all events. You can also change the file  names
  135. and locations for the eventlist and prefs files. The file
  136. that  is  included with the archive has all the  possible
  137. options  set.  Internal defaults exist in the  executable
  138. for  any which are missing from this file or if this file
  139. itself is missing.
  140.  
  141. See fconfig itself for more information.
  142.  
  143. The  two  fonts which can be set are for the gadget  text
  144. and  the  clock  and calendar text. The  latter  (set  in
  145. fconfig  as,  say _8X8_FONT=p0t-noodle.font)  must  be  a
  146. fixed 8x8 font.
  147.  
  148. The  colours  are  the first and last four  from  the  WB
  149. palette  and  should  remain correct regardless  of  your
  150. screen depth. Which are used for each part of the display
  151. may be changed in fconfig (rather laboriously, I admit).
  152.  
  153. 4.2 lconfig file
  154.  
  155. The  lconfig file contains all the text strings  used  in
  156. the  programme.  If it is not present then  the  internal
  157. English  defaults will be used, however, by changing  the
  158. strings  in  this  file it is possible  to  localise  the
  159. programme  for other languages. Care must be  taken  that
  160. the strings are entered in the same fixed order, and that
  161. they   consist  of  approximately  the  same  number   of
  162. characters.  The  strings for days and months  must  have
  163. spaces (for the days) and | dividers (for the months)  as
  164. in the English version. See lconfig for more details.
  165.  
  166.  
  167. 5.  TECHNICAL NOTES
  168.  
  169. Most  of  the time the programme sits idle, only checking
  170. for input every quarter of a second. This means there may
  171. be a slight delay when you first hit a gadget. As soon as
  172. a   gadget   is   hit   however,  the  programme   checks
  173. continuously for input, until a full minute  passes  with
  174. no user-action, when it goes back to its standby state.
  175.  
  176.  
  177. 6. OTHER INFO
  178.  
  179. Author:   Mike Child     mike@mikech.demon.co.uk
  180. Tools used:    Blitz Basic 2.1
  181. Written on:    A1200 Apollo060@66 32MB WB3.0
  182.  
  183. Thanks   to   the   subscribers  to   BlitzList   (blitz-
  184. list@netsoc.ucd.ie) for solving some queries.
  185.  
  186.  
  187. 7. HISTORY
  188.  
  189. Version 1.0 - Initial release
  190. Version 1.1 - Added automatic update of today indicator
  191.               in calendar at turn of midnight. 
  192.  
  193.